home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilCacheImg.z / ilCacheImg
Encoding:
Text File  |  2002-10-03  |  8.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg - class to implement image data caching
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilCacheImg implements an abstract model of cached image data.  The cache
  19.      assumes that the image data is stored in fixed-size  rectangles called
  20.      pages. The main purpose of this class is the definition of a common API
  21.      for cached image objects.  Like ilImage, ilCacheImg is an abstract class,
  22.      requiring further derivation to be used as an object.  The real work of
  23.      implementing a caching mechanism is deferred to derived classes such as
  24.      ilMemCacheImg.
  25.  
  26. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  27.      PPPPaaaaggggeeee MMMMaaaannnnaaaaggggeeeemmmmeeeennnntttt
  28.  
  29.           ilStatus ilCacheImgFlush(ilCacheImg *img, int discard)
  30.           size_t ilCacheImgGetCacheSize()
  31.  
  32.  
  33. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  34.      fffflllluuuusssshhhh(((())))
  35.  
  36.           ilStatus ilCacheImgFlush(ilCacheImg *img, int discard)
  37.  
  38.  
  39.           This is a virtual function that must be implemented by the derived
  40.           class.  Its purpose is to write any modified data in the cache to
  41.           the backing store (if such a concept is relevant to the derived
  42.           class).  Derived classes that access an image file can call this
  43.           function in their destructor before the file is closed to ensure
  44.           that all data is written. If _d_i_s_c_a_r_d is TRUE, then the data in the
  45.           cache, after it is written out, is invalidated and all cache
  46.           parameters are reset. If FALSE, then the data in the cache remains
  47.           valid.
  48.  
  49.      ggggeeeettttCCCCaaaacccchhhheeeeSSSSiiiizzzzeeee(((())))
  50.  
  51.           size_t ilCacheImgGetCacheSize()
  52.  
  53.  
  54.           This function returns the amount of cache memory, in bytes,
  55.           currently allocated by this image object.
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74. INHERITED MEMBER FUNCTIONS
  75.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  76.      ilAddInput(), ilAllocFillData(), ilClipTile(), ilClipTileAsTile(),
  77.      ilClipTileFloat(), ilClipTileFloatAsTile(),
  78.      ilConfigureRetainedCacheImage(), ilCopy(), ilCopyTile(), ilCopyTile3D(),
  79.      ilCopyTileCfg(), ilFillTile(), ilFillTile3D(), ilFillTileRGB(),
  80.      ilFreeFillData(), ilGetColorImg(), ilGetColorModel(), ilGetColormap(),
  81.      ilGetColormapPtr(), ilGetCompression(), ilGetConfig(), ilGetCsize(),
  82.      ilGetDataType(), ilGetDimensions(), ilGetDirectInput(),
  83.      ilGetDisplayCacheEnable(), ilGetFill(), ilGetFillData(),
  84.      ilGetFillValue(), ilGetHeight(), ilGetHwEnable(), ilGetHwHint(),
  85.      ilGetHwHintName(), ilGetHwIntHint(), ilGetHwIntHintName(), ilGetInput(),
  86.      ilGetInputTileRequirement(), ilGetLockTileSet(), ilGetMappedPageSize(),
  87.      ilGetMappedSize(), ilGetMaxColormapLevels(), ilGetMaxValue(),
  88.      ilGetMinValue(), ilGetNumChans(), ilGetNumInputs(), ilGetOrder(),
  89.      ilGetOrientation(), ilGetPageBorder(), ilGetPageBorderPtr(),
  90.      ilGetPageBorderX(), ilGetPageBorderY(), ilGetPageBorderZ(),
  91.      ilGetPageCounts(), ilGetPageDelta(), ilGetPageDeltaStruct(),
  92.      ilGetPageDimensions(), ilGetPageIndices(), ilGetPageOrigin(),
  93.      ilGetPageOriginC(), ilGetPageOriginStruct(), ilGetPageOriginX(),
  94.      ilGetPageOriginY(), ilGetPageOriginZ(), ilGetPageSize(),
  95.      ilGetPageSizeBytes(), ilGetPageSizeC(), ilGetPageSizePix(),
  96.      ilGetPageSizeStruct(), ilGetPageSizeVal(), ilGetPageSizeX(),
  97.      ilGetPageSizeXY(), ilGetPageSizeY(), ilGetPageSizeZ(), ilGetPixel(),
  98.      ilGetPixel3D(), ilGetPriority(), ilGetScaleMax(), ilGetScaleMin(),
  99.      ilGetSize(), ilGetSizePtr(), ilGetStrides(), ilGetSubTile(),
  100.      ilGetSubTile3D(), ilGetTile(), ilGetTile3D(), ilGetWidth(), ilGetXsize(),
  101.      ilGetYsize(), ilGetZsize(), ilHasPageBorder(), ilHasPages(),
  102.      ilInitScaleMinMax(), ilIsColorImg(), ilIsIntegral(),
  103.      ilIsMirrorOrientation(), ilIsSigned(), ilIsWritable(), ilLockPage(),
  104.      ilLockPageSet(), ilLockTile(), ilLockTile3D(), ilMapFlipTrans(),
  105.      ilMapFromInput(), ilMapFromInput2D(), ilMapFromInput3D(),
  106.      ilMapFromSource(), ilMapFromSource2D(), ilMapFromSource3D(),
  107.      ilMapOrientation(), ilMapSize(), ilMapTile(), ilMapTileFlipTrans(),
  108.      ilMapTileFloat(), ilMapToInput(), ilMapToInput2D(), ilMapToInput3D(),
  109.      ilMapToSource(), ilMapToSource2D(), ilMapToSource3D(), ilMapXY(),
  110.      ilMapXYFloat(), ilMapXYSign(), ilQCopyTileCfg(), ilQFillTile3D(),
  111.      ilQFillTileRGB(), ilQGetSubTile3D(), ilQGetTile3D(), ilQLockPageSet(),
  112.      ilQSetSubTile3D(), ilQSetTile3D(), ilRemoveHwHint(),
  113.      ilRemoveHwHintName(), ilRemoveInput(), ilSetColorModel(),
  114.      ilSetColormap(), ilSetCompression(), ilSetCsize(), ilSetDataType(),
  115.      ilSetDisplayCacheEnable(), ilSetFill(), ilSetFillValue(),
  116.      ilSetHwEnable(), ilSetHwHint(), ilSetHwIntHint(), ilSetHwIntHintName(),
  117.      ilSetInput(), ilSetMaxColormapLevels(), ilSetMaxValue(), ilSetMinValue(),
  118.      ilSetNumChans(), ilSetOrder(), ilSetOrientation(), ilSetPageBorder(),
  119.      ilSetPageBorderStruct(), ilSetPageSize(), ilSetPageSizeC(),
  120.      ilSetPageSizeStruct(), ilSetPageSizeXY(), ilSetPageSizeZ(), ilSetPixel(),
  121.      ilSetPixel3D(), ilSetPriority(), ilSetScaleMinMax(), ilSetScaleType(),
  122.      ilSetSize(), ilSetSubTile(), ilSetSubTile3D(), ilSetTile(),
  123.      ilSetTile3D(), ilSetXYsize(), ilSetXsize(), ilSetYsize(), ilSetZsize(),
  124.      ilUnlockPage(), ilUnlockPageSet()
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  141.      ilLinkClearSet(), ilLinkClearStatus(), ilLinkGetDescription(),
  142.      ilLinkGetDirectParent(), ilLinkGetDisabledIndex(), ilLinkGetFloatProp(),
  143.      ilLinkGetGenerationID(), ilLinkGetIntProp(), ilLinkGetNumChildren(),
  144.      ilLinkGetNumParents(), ilLinkGetParent(), ilLinkGetPtrProp(),
  145.      ilLinkGetRelatedChild(), ilLinkGetRelatedDelete(),
  146.      ilLinkGetRelatedType(), ilLinkGetStatus(), ilLinkIsAllowed(),
  147.      ilLinkIsAltered(), ilLinkIsEnabled(), ilLinkIsRelated(), ilLinkIsSet(),
  148.      ilLinkRemoveParent(), ilLinkRemoveProp(), ilLinkSetDescription(),
  149.      ilLinkSetDisabledIndex(), ilLinkSetEnabled(), ilLinkSetParent(),
  150.      ilLinkSetProp(), ilLinkSetRelatedDelete(), ilLinkSetRelatedType()
  151.  
  152. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  153.      ilImage, ilMemCacheImg
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.